Add basic documentation site #227
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
|
Would it be possible to add an updated version of the release tracker table to the docs? This would be a great place to list all supported ufuncs and where we could later document e.g. the ULPs for each function |
Member
|
Thanks @melissawm @juntyr yeah we will extend this, to add all those details |
| ] | ||
|
|
||
| docs = [ | ||
| "sphinx", |
Member
There was a problem hiding this comment.
@ngoldbaum (didn't explored in deep yet) Would this startup setup be extendable to your work (https://unyt.readthedocs.io/en/stable/)
Member
There was a problem hiding this comment.
Yeah, unyt also uses sphinx. It doesn't use myst because unyt predates myst.
I would defer to Melissa's setup. Maybe look at unyt if you're interested in setting up doctesting.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@SwayamInSync so sorry it took me so long!!
Here's a basic docs site setup. I haven't set up the website yet, but I can give you instructions later. Here's a preview of how the site looks like right now: https://melissawm.github.io/numpy-user-dtypes/